Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Code structure #83

Merged
merged 12 commits into from
Jun 27, 2019
Merged

Code structure #83

merged 12 commits into from
Jun 27, 2019

Conversation

nevrome
Copy link
Collaborator

@nevrome nevrome commented Jun 25, 2019

For the CRAN release of rrtools (#75), @benmarwick and I decided to restructure its code files to increase the general readability and maintainability. This PR contains a first draft of a new file structure.

What's new:

  • hello.R was divided into several code files. One file (core_...) for each main function of the package.
  • The helper functions -- many copied from the devtools package to avoid ::: dependencies -- were reorganized in thematic files (helpers_...) with a more or less unified layout.
  • Some helper functions, which are not in use any more, were removed.
  • Helper functions are no longer exported and their (mostly internal) roxygen documentation was removed.

Copy link
Owner

@benmarwick benmarwick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this huge effort, it looks excellent. I've cloned this PR locally, built, checked, tested, etc. and it's great.

@benmarwick benmarwick merged commit 0861b50 into master Jun 27, 2019
@benmarwick benmarwick deleted the code_structure branch June 27, 2019 05:47
@benmarwick
Copy link
Owner

I rarely use branches, but it looks like I could merge this without wrecking anything, so that's a relief! Thanks again for all your work organising those functions. It will be easier to maintain now!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants